字节跳动 Flutter UME Kits Competition 参赛指南
UME(flutter_ume,https://pub.dev/packages/flutter_ume)是由字节跳动 Flutter Infra 团队开发、维护的一款 Flutter 应用内调试工具。该工具已服务了字节跳动的内部业务近 2 年时间, 20 余业务接入并使用了 UME 以助力 Flutter 应用开发。
UME 是一个开放的 Flutter 应用内调试工具平台,最新版本的 UME 共集成了 22 款插件,代码贡献来自公司内及社区的开发者。任何开发者可以通过 UME 提供的开放 API 去创造适合自己业务的、有个性的调试工具插件。
📝 作品提交指南
创建插件包
flutter create -t <package或plugin> name_of_kit
在创建出来的包中,依赖 flutter_ume 进行开发
开发完成后充分自测,在 test 目录中添加单元测试(可参考 https://github.com/bytedance/flutter_ume/tree/master/kits/flutter_ume_kit_console/test 写法)
将插件演示效果截图或录屏保存到插件的 screenshots 目录下
将 pubspec.yaml、README.md 文件与 lib、test、screenshots 目录(若为 plugin 则还包括对应平台的 native 代码目录,如 ios、android、web、windows、macos、linux 等)一同压缩至 zip 压缩包,并以你的作品名称命名,如 name_of_kit.zip
在 README.md 中编写文档
将压缩包以附件的形式,发送至 ume-kits-competition@bytedance.com,标题为:"ume-kits-competition"。
💫 有效作品标准
参赛作品压缩包中必须具备 pubspec.yaml、README.md 文件与 lib、test、screenshots 目录,若为 plugin 则还包括对应平台的 native 代码目录
参赛作品代码需要支持 Null-safety,最低支持 Flutter 2.0 版本,必须包含 test 单元测试
在提交作品前,请务必在 flutter_ume 的 example 工程中将参赛作品接入测试,并成功运行 example 工程,插件功能正常使用
参赛作品需要在活动提交时间(xxx)内发送到参赛专用邮箱(ume-kits-competition@bytedance.com),以参赛邮箱接收到邮件的时间为准,不在活动提交时间内提交的作品无效
参赛作品一旦发送到参赛邮箱,即认同该代码将以 MIT 协议开源,并贡献至 flutter_ume 开源仓库。参赛选手对参赛作品代码版权负责,对于代码可能导致的版权、开源协议风险,承担责任
💡 注意事项
提交作品需要符合“有效作品标准”,对不符合标准的参赛作品将无资格参与评奖
若需要修改 flutter_ume 代码以支持插件能力,请 fork flutter_ume 仓库(https://github.com/bytedance/flutter_ume),修改代码,并向 flutter_ume 仓库提交 Pull Request。在提交作品的邮件正文中添加 Pull Request 的地址
对于存在代码相似、创意相同、功能类似的参赛作品,以提交时间为评奖依据
比赛组委会将在参赛作品评选结束后通过邮件联系参赛选手,请务必保持邮箱畅通